DOC-5804 experimental TCE binderhub links #2228

andy-stark-redis · 2025-10-10T13:37:49Z

This PR is about two things:

A draft implementation of a feature to add BinderHub links in each example tab that supports them. Basically, we have a new BINDER_ID special comment in the source file. The layout code picks this up and adds the appropriate link to BinderHub for the example.
Experimenting with the approach outlined in the blog David mentioned about Using Markdown as a programming language. I've started with the content of the Tabbed code example infrastructure page from the repo wiki and used that along with the existing code to generate a SPECIFICATION.md file with implementation/maintenance details. I then used that in steps to add the new code, prompting Augment to update the spec based on its "experience" with the implementation.

The Markdown programming experiment seems to have worked quite well (results-wise, at least). However, I realise we might not be ready to just go ahead and adopt this technique for the build scripts (we can easily remove the spec and new README file if we don't want to continue using them). Anyway, all feedback about this would be welcome :-)

As regards the BinderHub link, I think the "Run in browser" link might look better positioned next to the menu. Or, maybe we want a new icon on the right (just a Play button, say) that is similar to the existing icons? You get a tooltip when you hover on the link, but maybe it's best if we make it as conspicuous as possible since it's such a cool new feature. Again, all feedback welcome :-)

github-actions · 2025-10-10T13:38:01Z

DOC-5804

github-actions · 2025-10-10T13:38:04Z

Staging links:
https://redis.io/docs/staging/DOC-5804-exp-tce-binderhub-links/develop/clients/nodejs/
https://redis.io/docs/staging/DOC-5804-exp-tce-binderhub-links/develop/clients/redis-py/

jit-ci

❌ Jit has detected 2 important findings in this PR that you should review.
The findings are detailed below as separate comments.
It’s highly recommended that you fix these security issues before merge.

Repository Risks:

Database Integration: Connects to a database, often involving sensitive data that must be securely managed.
High Severity Findings: Indicates that the resource has high severity security findings that need attention.
Production: Critical as it operates in a live production environment, directly impacting users and business operations.

Repository Context:

graph LR
    GitHub$Repository_U23_redis/docs["GitHub Repository<br/>redis/docs"]:::GitHub$Repository
    Team_U23_docs_U2D_reviewers["Team<br/>docs-reviewers"]:::Team
    Team_U23_client_U2D_docs["Team<br/>client-docs"]:::Team
    Team_U23_core_U2D_team["Team<br/>core-team"]:::Team
    Team_U23_docs["Team<br/>docs"]:::Team
    DBIntegration_U23_redis["DBIntegration<br/>redis"]:::DBIntegration
    GitHub$Actions_U23_test_gcs_access_U2E_yml["GitHub Actions<br/>test_gcs_access.yml"]:::GitHub$Actions
    Team_U23_docs_U2D_reviewers -- "Owns" --> GitHub$Repository_U23_redis/docs
    Team_U23_client_U2D_docs -- "Owns" --> GitHub$Repository_U23_redis/docs
    Team_U23_core_U2D_team -- "Owns" --> GitHub$Repository_U23_redis/docs
    Team_U23_docs -- "Owns" --> GitHub$Repository_U23_redis/docs
    GitHub$Repository_U23_redis/docs -- "Is accessible to" --> DBIntegration_U23_redis
    GitHub$Repository_U23_redis/docs -- "Has" --> GitHub$Actions_U23_test_gcs_access_U2E_yml

jit-ci · 2025-10-10T13:39:35Z

build/tcedocs/SPECIFICATION.md

+│  │ Remote Examples  │         │ Local Examples   │              │
+│  │ (GitHub Repos)   │         │ (local_examples/)│              │
+│  └────────┬─────────┘         └────────┬─────────┘              │
+│           │                            │                         │


Security control: Secret Detection Trufflehog

Github

Github (Unverified)

Severity: HIGH

Why should you fix this issue?
This code introduces a hard-coded secrets issue. In a production environment, storing secrets like passwords or API keys directly in the code can lead to serious security risks. If these secrets are compromised, it could result in unauthorized access or manipulation of critical systems.

Jit Bot commands and options (e.g., ignore issue)

You can trigger Jit actions by commenting on this PR review:

#jit_ignore_fp Ignore and mark this specific single instance of finding as “False Positive”

#jit_ignore_accept Ignore and mark this specific single instance of finding as “Accept Risk”

#jit_ignore_type_in_file Ignore any finding of type "Github" in build/tcedocs/SPECIFICATION.md; future occurrences will also be ignored.

#jit_undo_ignore Undo ignore command

#jit_ignore_accept

jit-ci · 2025-10-10T13:39:35Z

build/tcedocs/SPECIFICATION.md

+- **Code hiding/highlighting**: Support for hiding boilerplate code and highlighting relevant sections
+- **Named steps**: Break examples into logical steps that can be referenced individually
+- **Remote and local examples**: Pull examples from client library repositories or use local examples
+- **Syntax highlighting**: Automatic syntax highlighting based on language


Security control: Secret Detection Trufflehog

Github

Github (Unverified)

Severity: HIGH

Why should you fix this issue?
This code introduces a hard-coded secrets issue. In a production environment, storing secrets like passwords or API keys directly in the code can lead to serious security risks. If these secrets are compromised, it could result in unauthorized access or manipulation of critical systems.

Jit Bot commands and options (e.g., ignore issue)

You can trigger Jit actions by commenting on this PR review:

#jit_ignore_fp Ignore and mark this specific single instance of finding as “False Positive”

#jit_ignore_accept Ignore and mark this specific single instance of finding as “Accept Risk”

#jit_ignore_type_in_file Ignore any finding of type "Github" in build/tcedocs/SPECIFICATION.md; future occurrences will also be ignored.

#jit_undo_ignore Undo ignore command

The "hard-coded secret" in question just seems to be the Github commit ID used by the BinderHub examples (we would have this in the doc files or source files anyway, so it's not really "secret"). Is everyone OK if I mark this as ignored for this particular file?

paoloredis

This is great.

jit-ci

❌ Jit has detected 1 important finding in this PR that you should review.
The finding is detailed as a comment.
It’s highly recommended that you fix this security issue before merge.

Until now, you ignored/fixed 1 finding.

andy-stark-redis · 2025-10-13T10:36:16Z

Thanks @paoloredis !

jit-ci

❌ Jit has detected 2 important findings in this PR that you should review.
The findings are detailed as separate comments.
It’s highly recommended that you fix these security issues before merge.

Until now, you ignored/fixed 2 findings.

jit-ci · 2025-10-14T14:53:04Z

build/tcedocs/SPECIFICATION.md

+- Handle language-specific client name mapping (e.g., Java-Sync vs Java-Async)
+
+**Key Functions**:
+- `process_local_examples()`: Main processing function


Security control: Secret Detection Trufflehog

Github

Github (Unverified)

Severity: HIGH

Why should you fix this issue?
This code introduces a hard-coded secrets issue. In a production environment, storing secrets like passwords or API keys directly in the code can lead to serious security risks. If these secrets are compromised, it could result in unauthorized access or manipulation of critical systems.

Jit Bot commands and options (e.g., ignore issue)

You can trigger Jit actions by commenting on this PR review:

#jit_ignore_fp Ignore and mark this specific single instance of finding as “False Positive”

#jit_ignore_accept Ignore and mark this specific single instance of finding as “Accept Risk”

#jit_ignore_type_in_file Ignore any finding of type "Github" in build/tcedocs/SPECIFICATION.md; future occurrences will also be ignored.

#jit_undo_ignore Undo ignore command

jit-ci · 2025-10-14T14:53:04Z

build/tcedocs/SPECIFICATION.md

+- Understand the system → [System Overview](#system-overview), [Architecture](#architecture)
+- Add a new example → [Working with Examples](#working-with-examples)
+- Add a new language → [Extension Points](#extension-points), [Appendix: Adding a Language](#adding-a-language)
+- Fix a build issue → [Troubleshooting](#troubleshooting)


Security control: Secret Detection Trufflehog

Github

Github (Unverified)

Severity: HIGH

Why should you fix this issue?
This code introduces a hard-coded secrets issue. In a production environment, storing secrets like passwords or API keys directly in the code can lead to serious security risks. If these secrets are compromised, it could result in unauthorized access or manipulation of critical systems.

Jit Bot commands and options (e.g., ignore issue)

You can trigger Jit actions by commenting on this PR review:

#jit_ignore_fp Ignore and mark this specific single instance of finding as “False Positive”

#jit_ignore_accept Ignore and mark this specific single instance of finding as “Accept Risk”

#jit_ignore_type_in_file Ignore any finding of type "Github" in build/tcedocs/SPECIFICATION.md; future occurrences will also be ignored.

#jit_undo_ignore Undo ignore command

andy-stark-redis · 2025-10-14T14:53:49Z

#jit_ignore_type_in_file

andy-stark-redis added 8 commits October 6, 2025 16:31

DOC-5804 first attempt at making specification doc for TCEs

035092c

DOC-5804 replaced inline Python landing examples with local source file

3b730f7

DOC-5804 updated spec for new special comment

d2b5862

DOC-5804 added build code changes to extract value into

01a38f8

DOC-5804 updated spec based on implementation 'experience'

6dac075

DOC-5804 updated spec for BinderHub example tab link

b4ddd1c

DOC-5804 added binder link to example tabs

decf0f3

DOC-5804 updated spec based on 'experience'

0456155

andy-stark-redis requested a review from a team October 10, 2025 13:37

andy-stark-redis self-assigned this Oct 10, 2025

andy-stark-redis added do not merge yet clients Client library docs labels Oct 10, 2025

jit-ci bot reviewed Oct 10, 2025

View reviewed changes

andy-stark-redis changed the title ~~DOC-5804 exp tce binderhub links~~ DOC-5804 experimental TCE binderhub links Oct 10, 2025

andy-stark-redis requested review from dwdougherty and paoloredis October 10, 2025 13:42

paoloredis approved these changes Oct 13, 2025

View reviewed changes

jit-ci bot reviewed Oct 13, 2025

View reviewed changes

DOC-5804 updated format and added Node.js landing page

2ed7124

jit-ci bot reviewed Oct 14, 2025

View reviewed changes

andy-stark-redis merged commit 601f8f9 into main Oct 14, 2025
6 of 8 checks passed

andy-stark-redis deleted the DOC-5804-exp-tce-binderhub-links branch October 14, 2025 14:56

DOC-5804 experimental TCE binderhub links #2228

DOC-5804 experimental TCE binderhub links #2228

Uh oh!

Conversation

andy-stark-redis commented Oct 10, 2025

Uh oh!

github-actions bot commented Oct 10, 2025 • edited by atlassian bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Oct 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jit-ci bot left a comment

Choose a reason for hiding this comment

Uh oh!

jit-ci bot Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

andy-stark-redis Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

jit-ci bot Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

andy-stark-redis Oct 10, 2025

Choose a reason for hiding this comment

Uh oh!

paoloredis Oct 13, 2025

Choose a reason for hiding this comment

Uh oh!

paoloredis left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jit-ci bot left a comment

Choose a reason for hiding this comment

Uh oh!

andy-stark-redis commented Oct 13, 2025

Uh oh!

jit-ci bot left a comment

Choose a reason for hiding this comment

Uh oh!

jit-ci bot Oct 14, 2025

Choose a reason for hiding this comment

Uh oh!

jit-ci bot Oct 14, 2025

Choose a reason for hiding this comment

Uh oh!

andy-stark-redis commented Oct 14, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented Oct 10, 2025 •

edited by atlassian bot

Loading

github-actions bot commented Oct 10, 2025 •

edited

Loading

paoloredis left a comment •

edited

Loading